Flow-Cal Send Gas Quality Commands

Device Communication: Flow-Cal Send Gas Quality

Note: This command is provided as an optional feature, in REPOSITORY mode only, and via scheduling or scripting only. For this command to function, certain requirements must be met.

If installed, Flow-Cal Send Gas Quality (SENDFCGQ via script) is the command that triggers the FMS to scan a specified Flow-Cal database in order to retrieve and process Flow-Cal send gas quality requests and send those gas quality records to field devices. The command is executed for the system, not for specific Nodes.

To also import the gas quality data into FMS, do one of the following to request the gas quality configuration data from the device.

Automatically poll the device for configuration data - Prior to execution of the Flow-Cal Send Gas Quality command, set the Request config after successful send parameter to Yes to automatically poll the device for configuration data (including the gas quality data sent via the command) after the file import command succeeds.
Manually request configuration data from the device - After successful completion of the Flow-Cal Send Gas Quality command, execute a Request Current Configuration command to request configuration data from the device (including the gas quality data sent via the command).

Note: This command is available only via the Master Scheduling Service in CygNet Explorer or via scripting (not through the FMS Explorer user interface).

You must have proper security authorization to execute this command. See FMS Security (and CMDDEV security event) for information about configuring security access for FMS commands.

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.

See CxFms for more information about scripting commands.

Command Requirements

To enable the command to send Flow-Cal gas quality data to devices, the following elements must be present.

Flow-Cal Database connection — A connection must be established between the FMS and the service hosting the Flow-Cal database, and database connectivity must be available to the FMS. The database connection is defined in the FMS service configuration file (CygNet\Services\FMS\fms.cfg) via a set of FCDB Database Info keywords. See FMS Configuration File Keywords for more information about configuring the Database Info Keywords to support the Flow-Cal database connection.
Flow-Cal Export DLL — CygNet Measurement provides an optional DLL file that must be installed on your system to support data exports from FMS to Flow-Cal. The file (CxFmsFlowCalExport.dll) must be installed and registered in the CygNet\Support folder on the computer hosting your FMS. See Installing CygNet Measurement for more information about installation and registration of the export DLL file.

Note: Refer to Flow-Cal documentation and/or contact your Flow-Cal representative for the most current information about specific Flow-Cal configuration details.

Flow-Cal Send Gas Quality Process

The Flow-Cal gas quality record to send to a device is processed as follows.

When the gas quality request is sent, the FMS will attempt to connect to the specified Flow-Cal database, as configured in the FMS configuration file (CygNet\Services\FMS\fms.cfg).
If the FMS can successfully connect to the Flow-Cal database, it will scan the database for send gas quality requests. If there are requests for sending gas quality records present in the Flow-Cal database, then FMS will retrieve and process the gas quality request, and then send the gas quality data to the field devices.
If the FMS cannot successfully connect to the Flow-Cal database, then the failure to connect will be logged as an error by the FMS.

Note: Gas quality values are sent to the device with the same units contained in the most recent raw configuration log record collected from the device.

See Viewing Command Logs for information about viewing historical logs for this command.

Configuring a Flow-Cal Send Gas Quality Command

The Flow-Cal Send Gas Quality command is run against the FMS service, rather than against specific Nodes, and can only be executed via the Master Scheduling Service (MSS) in CygNet Explorer or via scripting.

Command Definition Properties

The following command definition properties apply to Flow-Cal Send Gas Quality commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low - displays errors Medium - displays errors and warnings High - displays errors, warnings, and additional information applicable to the command Default value is Low level logging.

Command Parameters

The following command parameters apply to Flow-Cal Send Gas Quality commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter	Description	Type	Usage Notes
DataMatch	Skip if data matches	String Enum	If used, double-click to access the Skip if Data Matches dialog box. Select one of the following options. Yes (YES via script) No (NO via script) This parameter is optional. Default value is No.
StatPtUdc	Status point UDC	String	If used, double-click to access the Enter Status Point UDC dialog box. Specify the UDC of the status point that monitors the status of the command. (The command will run whether or not it is monitored by a status point.) Type the status point UDC into the text box. The UDC will be combined with the field device Facility ID. This parameter is optional.
ImpGetCon	Request config after successful send	String Enum	Double-click to access the Request Config After Successful Send dialog box. Select whether or not to automatically request current configuration for the device once the data send action has been successfully completed. Options are as follows. Yes (YES via script) No (NO via script) Set to Yes if you also want to automatically import the configuration data into FMS. Set to No if you do not want to import the configuration data into FMS, or if you want to do so manually. This parameter is required.
ImpGroup	Add devices to group	String	If used, double-click to access the Enter Add Devices to Group dialog box. In the text box, type the name of the group to which you want devices added. Devices will be added to this group when both of the following are true. The gas quality data send was successful If the value of ImpGetCon is Yes, the configuration poll was successful Note: Nodes added to this group are added for the entire span of the Node or group (whichever is less). This parameter is optional.
ImpClrGrp	Clear existing group entries	String Enum	If used, double-click to access the Clear Existing Group Entries dialog box. Select one of the following options. Yes (YES via script) No (NO via script) If set to Yes, and a value has been specified for ImpGroup, any existing entries will be removed from the specified group before executing the command. If set to No, the existing group entries will be retained when executing the command. Note: Nodes cleared from this group are cleared for the entire span of the Node or group. This parameter is optional.
ImpMxRun	Max runtime (minutes)	Integer	Double-click to access the Enter Max Run Time (minutes) dialog box. Enter the number of minutes to allow the command to run before it will timeout. Note: Entering a value of 0 causes the command to run indefinitely. This parameter is required.